CIMPLICITY Configuration REST API Web Service
CIMPLICITY Configuration REST API Web Service / All Operations Resource Group / /projects/{projectId}/SQLConnections (Get)
In This Topic
    Get/projects/{projectId}/SQLConnections
    In This Topic
    Description
    Gets an array of SQL connections objects that satisfy the query criteria
    Parameters
    NameDescriptionData Type
    projectIdthe id of the projectstring
    Table_idfilters the list of connections based on the table_idstring
    ConnectionTypeprovides a wild card string to filter sql connections by their connection type.(undefined)
    200 Response

    The response body is of type SQLGetResponse.

    The collection of sql connections that satisfy the query.

    Overview

    SQLGetResponse
    The results of the points get query
    SQLDefaultConnections : Array[CimSQLConnection]
    ConnectionType : CimSQLConnectionType
    ODBCDataSource : string
    UserID : string
    Passsword : string
    ReconnectWaitPeriod : integer
    ReconnectWaitUnit : CimTimeUnitEnum
    EnableStoreAndForward : boolean
    MaxNumberOfStoredRecord : number
    SQLTableConnections : Array[CimSQLTableConnection]
    Table_id : string
    SQLConnection : CimSQLConnection
    ConnectionType : CimSQLConnectionType
    ODBCDataSource : string
    UserID : string
    Passsword : string
    ReconnectWaitPeriod : integer
    ReconnectWaitUnit : CimTimeUnitEnum
    EnableStoreAndForward : boolean
    MaxNumberOfStoredRecord : number
    Fault Responses
    FaultDescription
    404This fault returns a response body of type ProblemDetails.
    Error if objects not found
    400This fault returns a response body of type .
    General error
    See Also
    All Operations Resource Group | CIMPLICITY Configuration REST API Web Service

     

     

    © 2024 GE Vernova and/or its affiliates. All rights reserved.

    Send comments on this topic.